跳到主要内容

自定义设置

hide​

隐藏设置界面

  • 返回
    • valid (boolean) - 是否合法
local res = base.setting:hide()

show​

显示设置界面

  • 返回
    • valid (boolean) - 是否合法
local res = base.setting:show()

is_visible​

是否显示

  • 返回
    • visible (boolean) - 是否显示
local visible = base.setting:is_visible()

save_option​

把某一个key对应的value存下来（一个key只对应一个value，重复保存会覆盖），部分功能已经在c++实现

  • 参数
    • key (string) - 该设置的名字
    • value (string/number/bool) - 该设置对应的值
      • string ： 对应字符串
      • bool ： 布尔值
      • number ： 浮点数
base.settings:save_option('particle_lod_level', 'particle_level_height')

get_option​

获取某一个key对应的value

  • 参数
    • key (string) - 该设置的名字
  • 返回
    • value (string/number/bool) - 该设置对应的值
local param = base.settings:get_option('particle_lod_level')

set_option​

设置某一个key对应的value，调用设置函数和注册的回调函数，但并不把值保存起来，用于设置默认值

  • 参数
    • key (string) - 该设置的名字
    • value (string/number/bool) - 该设置对应的值
      • string ： 对应字符串
      • bool ： 布尔值
      • number ： 浮点数
base.settings:set_option('particle_lod_level', 'particle_level_height')

register_option​

注册一个回调，当save的时候会触发回调

  • 参数
    • key (string) - 该设置的名字
    • function (function) - 回调函数，传入的参数是key对应的value
base.settings:register_option('particle_lod_level', function(val) print(val) end)

set_default_option​

为一个地图下的key设置默认值

  • 参数
    • key (string) - 该设置的名字
    • value (string/number/bool) - 该设置对应的值
      • string ： 对应字符串
      • bool ： 布尔值
      • number ： 浮点数
base.settings:set_default_option('master_sound', 50)

c++实现的功能和对应的key​

音量相关​

"master_sound"
"effect_sound"
"ambient_sound"
"voice_sound"
"music_sound"
"background_music_sound"

粒子​

"particle_lod_level", {'particle_level_height', 'particle_level_middle', 'particle_level_low'}

帧率​

"max_fps"

场景相关​

使用get_option查询某一个key时，返回结果的优先级从高到低的顺序为：当前地图下用户设置的值->当前地图设置的默认值->游戏大厅中用户设置的值->游戏大厅设置的默认值，如果都没有就返回空，启动页会被算作大厅 注册的回调不会判断场景，重复注册会覆盖